| Package | uk.nhsdigital.medicines.r4.test |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=uk.nhsdigital.medicines.r4.test@2.8.21-prerelease&canonical=https://fhir.nhs.uk/CapabilityStatement/apim-medicines-facade |
| Url | https://fhir.nhs.uk/CapabilityStatement/apim-medicines-facade |
| Version | 0.1.0 |
| Status | draft |
| Date | 2022-11-07T00:00:00+00:00 |
| Name | APIMMedicinesFacade |
| Experimental | True |
| Description | Conformance requirements for NHS Digital EPS Facade API |
| Kind | requirements |
No resources found
| OperationDefinition | |
https://fhir.nhs.uk/OperationDefinition/MessageHeader-prepare-message  | MessageheaderPrepareMessage |
| https://fhir.nhs.uk/OperationDefinition/prescription-release | PrescriptionRelease |
| https://fhir.nhs.uk/OperationDefinition/MessageHeader-process-message | ProcessMessage |
| https://fhir.nhs.uk/OperationDefinition/verify-signature | VerifySignature |
| https://fhir.nhs.uk/StructureDefinition/NHSDigital-Claim | NHSDigitalClaim |
| https://fhir.nhs.uk/StructureDefinition/NHSDigital-Task-EPS | NHSDigitalTaskEPS |
FHIR{
"resourceType" : "CapabilityStatement",
"id" : "apim-medicines-facade",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Package",
"extension" : [
{
"url" : "FHIRPackage",
"extension" : [
{
"url" : "name",
"valueString" : "uk.nhsdigital.r4"
}
]
},
{
"url" : "FHIRPackage",
"extension" : [
{
"url" : "name",
"valueString" : "uk.nhsdigital.medicines.r4"
}
]
},
{
"url" : "FHIRPackage",
"extension" : [
{
"url" : "name",
"valueString" : "fhir.r4.ukcore.stu1"
},
{
"url" : "version",
"valueString" : "0.5.1"
}
]
},
{
"url" : "openApi",
"extension" : [
{
"url" : "documentation",
"valueUrl" : "https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-fhir"
},
{
"url" : "description",
"valueString" : "Electronic Prescription Service - FHIR API"
}
]
}
]
}
],
"url" : "https://fhir.nhs.uk/CapabilityStatement/apim-medicines-facade",
"version" : "0.1.0",
"name" : "APIMMedicinesFacade",
"status" : "draft",
"experimental" : "true",
"date" : "2022-11-07T00:00:00+00:00",
"publisher" : "digital.nhs.uk",
"description" : "Conformance requirements for NHS Digital EPS Facade API",
"kind" : "requirements",
"implementationGuide" : [
"https://simplifier.net/guide/nhsdigital-medicine",
"https://simplifier.net/guide/nhsdigital"
],
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+json"
],
"rest" : [
{
"mode" : "server",
"security" : {
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "OAuth",
"display" : "OAuth2 Token"
}
]
}
]
},
"resource" : [
{
"type" : "Claim",
"profile" : "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Claim",
"interaction" : [
{
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension" : [
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : true
},
{
"url" : "description",
"valueMarkdown" : "A valid secondary care Claim message. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Claim)."
},
{
"url" : "value",
"valueReference" : {
"reference" : "Claim/e8e75676-9d30-45f8-8b09-696818e7f4ca"
}
}
]
}
]
}
],
"code" : "create",
"documentation" : "Claim for a dispensed prescription - Dispensing"
}
]
},
{
"type" : "Task",
"profile" : "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Task-EPS",
"documentation" : "Download prescription, return a downloaded prescription, withdraw a dispense notification or search for summary details about a prescription",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension" : [
{
"url" : "required",
"valueString" : "identifier"
}
]
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension" : [
{
"url" : "required",
"valueString" : "focus:identifier"
}
]
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension" : [
{
"url" : "required",
"valueString" : "patient:identifier"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension" : [
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : true
},
{
"url" : "value",
"valueReference" : {
"reference" : "Task/ee1b55f8-113c-4725-99a3-25fbad366dd6"
}
},
{
"url" : "summary",
"valueMarkdown" : "Return a downloaded prescription - Dispensing"
},
{
"url" : "description",
"valueMarkdown" : "A valid request to return a prescription. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Task)."
}
]
},
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : true
},
{
"url" : "value",
"valueReference" : {
"reference" : "Task/6a2624a2-321b-470e-91a6-8ae7a065e2f0"
}
},
{
"url" : "summary",
"valueMarkdown" : "Withdraw a dispense notification - Dispensing"
},
{
"url" : "description",
"valueMarkdown" : "A valid request to withdraw a dispense notification. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Task)."
}
]
}
]
}
],
"code" : "create",
"documentation" : "Return a downloaded prescription or withdraw a dispense notification"
},
{
"code" : "search-type",
"documentation" : "Search for summary details about a prescription"
}
],
"operation" : [
{
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension" : [
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : true
},
{
"url" : "value",
"valueReference" : {
"reference" : "Parameters/45a3cbe4-7688-418b-91d3-8f6d5ca94905"
}
},
{
"url" : "description",
"valueMarkdown" : "A valid release request. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/OperationDefinitionrelease)."
}
]
}
]
}
],
"name" : "prescription-release",
"definition" : "https://fhir.nhs.uk/OperationDefinition/prescription-release"
}
],
"searchParam" : [
{
"name" : "identifier",
"type" : "token",
"documentation" : "The short form identifier of the prescription you are searching for.",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension" : [
{
"url" : "minimum",
"valueInteger" : 0
},
{
"url" : "maximum",
"valueInteger" : 1
},
{
"url" : "exampleParameter",
"valueString" : "f28682c0-50d2-472a-a8f0-477f7ac1b63f"
}
]
}
]
},
{
"name" : "focus:identifier",
"type" : "token",
"documentation" : "The short form identifier of the prescription you are searching for.",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension" : [
{
"url" : "minimum",
"valueInteger" : 0
},
{
"url" : "maximum",
"valueInteger" : 1
},
{
"url" : "exampleParameter",
"valueString" : "f28682c0-50d2-472a-a8f0-477f7ac1b63f"
}
]
}
]
},
{
"name" : "patient:identifier",
"type" : "token",
"documentation" : "The NHS Number of the patient whose prescriptions you are searching for.",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension" : [
{
"url" : "minimum",
"valueInteger" : 0
},
{
"url" : "maximum",
"valueInteger" : 1
},
{
"url" : "exampleParameter",
"valueString" : "https://fhir.nhs.uk/Id/nhs-number|9000000009"
}
]
}
]
},
{
"name" : "authored-on",
"type" : "date",
"documentation" : "Date the prescription was authored",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension" : [
{
"url" : "minimum",
"valueInteger" : 0
},
{
"url" : "maximum",
"valueInteger" : 1
},
{
"url" : "exampleParameter",
"valueString" : "eq2004-09-20"
}
]
}
]
},
{
"name" : "business-status",
"type" : "token",
"documentation" : "The state that a prescription is in.",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension" : [
{
"url" : "minimum",
"valueInteger" : 0
},
{
"url" : "maximum",
"valueInteger" : 1
},
{
"url" : "allowedValues",
"valueReference" : {
"reference" : "https://fhir.nhs.uk/ValueSet/DM-task-business-status"
}
}
]
}
]
},
{
"name" : "status",
"type" : "token",
"documentation" : "Search by task status",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension" : [
{
"url" : "minimum",
"valueInteger" : 0
},
{
"url" : "maximum",
"valueInteger" : 1
},
{
"url" : "showCodeAndSystem",
"valueBoolean" : false
},
{
"url" : "allowedValues",
"valueReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/task-status"
}
}
]
}
]
}
]
}
],
"operation" : [
{
"name" : "process-message",
"definition" : "https://fhir.nhs.uk/OperationDefinition/MessageHeader-process-message",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension" : [
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : false
},
{
"url" : "value",
"valueReference" : {
"reference" : "Bundle/30d65c8e-98e8-4806-b6a6-51e94733f0e9"
}
},
{
"url" : "description",
"valueMarkdown" : "A valid secondary care prescription-order message."
}
]
}
]
}
]
},
{
"name" : "verify-signature",
"definition" : "https://fhir.nhs.uk/OperationDefinition/verify-signature",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension" : [
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : true
},
{
"url" : "value",
"valueReference" : {
"reference" : "Bundle/155e1102-9e71-4f19-9453-b905c0bbc494"
}
},
{
"url" : "description",
"valueMarkdown" : "A valid signature verification request."
}
]
}
]
}
]
},
{
"name" : "prepare",
"definition" : "https://fhir.nhs.uk/OperationDefinition/MessageHeader-prepare-message",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension" : [
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : true
},
{
"url" : "value",
"valueReference" : {
"reference" : "Bundle/aef77afb-7e3c-427a-8657-2c427f71a271"
}
},
{
"url" : "description",
"valueMarkdown" : "A valid secondary care prepare request. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Messageprescription-order)."
}
]
}
]
}
]
}
]
}
],
"messaging" : [
{
"supportedMessage" : [
{
"mode" : "receiver",
"definition" : "https://fhir.nhs.uk/MessageDefinition/prescription-order",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension" : [
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : true
},
{
"url" : "value",
"valueReference" : {
"reference" : "Bundle/30d65c8e-98e8-4806-b6a6-51e94733f0e9"
}
},
{
"url" : "description",
"valueMarkdown" : "A valid secondary care prescription-order message."
}
]
}
]
}
]
},
{
"mode" : "receiver",
"definition" : "https://fhir.nhs.uk/MessageDefinition/prescription-order-update",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension" : [
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : true
},
{
"url" : "value",
"valueReference" : {
"reference" : "Bundle/0a1fd9ef-a3d5-4e95-84cd-552070a03086"
}
},
{
"url" : "description",
"valueMarkdown" : "A valid secondary care prescription-order-update message. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Messageprescription-order-update)."
}
]
}
]
}
]
},
{
"mode" : "receiver",
"definition" : "https://fhir.nhs.uk/MessageDefinition/dispense-notification",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension" : [
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : true
},
{
"url" : "value",
"valueReference" : {
"reference" : "Bundle/166f1103-3r67-73dw-7364-s395c4itv284"
}
},
{
"url" : "description",
"valueMarkdown" : "A valid secondary care dispense-notification message. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Messagedispense-notification)."
}
]
}
]
}
]
},
{
"mode" : "receiver",
"definition" : "https://fhir.nhs.uk/MessageDefinition/dispense-notification-update",
"extension" : [
{
"url" : "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension" : [
{
"url" : "example",
"extension" : [
{
"url" : "request",
"valueBoolean" : true
},
{
"url" : "value",
"valueReference" : {
"reference" : "Bundle/1e9d39ef-e999-4ab5-8fa1-bf8a0ff0ea98"
}
}
]
}
]
}
]
}
]
}
],
"text" : {
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.